<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: BLE ECO      (Bluetooth&reg; LE ECO Clock)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__ble__clk.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a>  </div>
  <div class="headertitle">
<div class="title">BLE ECO (Bluetooth&reg; LE ECO Clock)</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>This driver provides an API to manage the BLE ECO clock block. </p>
<p>The functions and other declarations used in this driver are in cy_ble_clk.h. You can include cy_pdl.h to get access to all functions and declarations in the PDL.</p>
<p>The BLE ECO clock is a high-accuracy high-frequency clock that feeds the link-layer controller and the radio Phy.</p>
<p>This clock is also an input to the system resources subsystem as an alternative high-frequency clock source (ALTHF).</p>
<h1><a class="anchor" id="group_ble_configuration_considerations"></a>
Configuration Considerations</h1>
<p>To configure the BLE ECO clock, call <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7" title="This API configures and enables the BLE ECO clock. ">Cy_BLE_EcoConfigure()</a>.</p>
<p>The following code shows how to configure the BLE ECO clock: </p><div class="fragment"><div class="line">    <span class="comment">/* BLE ECO configuration: ECO Frequency: 32 MHZ, Divider: 2 */</span></div><div class="line">    <span class="comment">/* Start-up time(uS): 1500, Load cap(pF): 9.9 */</span></div><div class="line">    </div><div class="line">    uint32_t startTime = (uint32_t)(1500 / 31.25);</div><div class="line">    uint32_t loadCap   = (uint32_t)((9.9 - 7.5) / 0.075);</div><div class="line">    </div><div class="line">    <span class="comment">/* Configure the BLE ECO clock */</span></div><div class="line">    (void) <a class="code" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7">Cy_BLE_EcoConfigure</a>(<a class="code" href="group__group__ble__clk__data__type.html#gga90f34ffaefcfb39107f8f60a2a910b10ab18e06510cdcdff510803020cadaed89">CY_BLE_BLESS_ECO_FREQ_32MHZ</a>, <a class="code" href="group__group__ble__clk__data__type.html#ggaa50dfcc9b2d385a197421f2262e462ffadc32f9a281d44abf83fab992d183fd9b">CY_BLE_SYS_ECO_CLK_DIV_2</a>, loadCap, startTime, <a class="code" href="group__group__ble__clk__data__type.html#gga0b65a546765caf85918c9f06e66d25fbabf04e7c9f17091dcbaecd4c80978d021">CY_BLE_ECO_VOLTAGE_REG_AUTO</a>);</div><div class="line">    </div><div class="line">    <span class="comment">/* In case if there is a need to get the BLE ECO frequency */</span></div><div class="line">    uint32_t bleEcoFreq = <a class="code" href="group__group__sysclk__alt__hf__funcs.html#gaf948bdd0d4b0fbf2774642db55eea712">Cy_SysClk_AltHfGetFrequency</a>();</div></div><!-- fragment --> <h1><a class="anchor" id="group_ble_clk_more_information"></a>
More Information</h1>
<p>See the BLE chapter of the device technical reference manual (TRM).</p>
<h1><a class="anchor" id="group_ble_clk_changelog"></a>
Changelog</h1>
<table class="doxtable">
<tr>
<th>Version</th><th>Changes</th><th>Reason of Change </th></tr>
<tr>
<td>3.70 </td><td>Added support for TRAVEO&trade; II Body Entry devices.<br />
 Functionality added to address devices without buck controllers. </td><td>Code enhancement and support for new devices.  </td></tr>
<tr>
<td>3.60 </td><td>MISRA </td><td>Resolve MISRA 2012 standard defects.  </td></tr>
<tr>
<td>3.50 </td><td>Updated <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7">Cy_BLE_EcoConfigure</a>, <a class="el" href="group__group__ble__clk__functions.html#ga16fab0f8f0dfb9ee67375a5607fef7bb">Cy_BLE_EcoReset</a> functions for PSoC 64 devices. Now the <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7">Cy_BLE_EcoConfigure</a> function can return PRA driver status value for PSoC 64 devices. </td><td>The BLE ECO clock driver uses the PRA driver to change the frequency value on the protected side. A BLE ECO clock driver function that calls a PRA driver function will return the PRA error status code if the called PRA function returns an error. In these cases, refer to PRA return statuses. Refer to functions description for details.  </td></tr>
<tr>
<td>3.40.1 </td><td>Minor documentation updates. </td><td>Documentation enhancement.  </td></tr>
<tr>
<td>3.40 </td><td>A new API function <a class="el" href="group__group__ble__clk__functions.html#gacb085ed4fdaa3bcf7b0582d72c9e7d2c">Cy_BLE_EcoIsEnabled()</a> is added. </td><td>API enhancement.  </td></tr>
<tr>
<td>3.30 </td><td>Updated the <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7">Cy_BLE_EcoConfigure()</a> to reuse the <a class="el" href="group__group__sysclk__clk__peri__funcs.html#ga8db0b9f751e98d8b19054e0879f965c4">Cy_SysClk_ClkPeriGetFrequency()</a>. </td><td>API enhancement.  </td></tr>
<tr>
<td>3.20 </td><td>Updated the <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7" title="This API configures and enables the BLE ECO clock. ">Cy_BLE_EcoConfigure()</a>: it stores the ECO frequency for possible frequency calculation by the <a class="el" href="group__group__sysclk__clk__hf__funcs.html#gafa8c21271b8cb1b1fd9f7fb489a8d2b3" title="Reports the frequency of the selected clkHf. ">Cy_SysClk_ClkHfGetFrequency()</a>. </td><td>API enhancement.  </td></tr>
<tr>
<td>3.10 </td><td>Updated the <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7" title="This API configures and enables the BLE ECO clock. ">Cy_BLE_EcoConfigure()</a> use case, when the voltageReg parameter is CY_BLE_ECO_VOLTAGE_REG_BLESSLDO and the Buck core regulator is enabled. </td><td>Defect fixing: Before, when the <a class="el" href="group__group__ble__clk__functions.html#gae92f61cd532c63d9547c52ccd6757ff7" title="This API configures and enables the BLE ECO clock. ">Cy_BLE_EcoConfigure()</a> function included the BLE LDO regulator option, the function returned CY_BLE_ECO_HARDWARE_ERROR if the Buck core regulator had been enabled.  </td></tr>
<tr>
<td>3.0 </td><td>The initial version. <br />
 The functionality of the BLE ECO clock is migrated from the BLE Middleware to the separated driver (ble_clk). </td><td>Independent usage of BLE ECO clock without BLE Middleware.  </td></tr>
</table>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__ble__clk__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ble__clk__functions.html">Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__ble__clk__data__type"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ble__clk__data__type.html">Enumerated Types</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__ble__clk__macros"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ble__clk__macros.html">Macros</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
